[tune] Fix TrialTerminationReporter in docs #29254
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: linusbiostat <[email protected]>
linusbiostat
requested review from
richardliaw,
krfricke,
xwjiang2010,
amogkam,
matthewdeng,
Yard1,
maxpumperla and
a team
as code owners
linusbiostat
changed the title
Yard1
reviewed
Oct 12, 2022
| @@ -52,9 +52,11 @@ Extending ``CLIReporter`` lets you control reporting frequency. For example: | |||
|
|
|||
| tuner = tune.Tuner(my_trainable, run_config=air.RunConfig(progress_reporter=ExperimentTerminationReporter())) | |||
| results = tuner.fit() | |||
|
|
|||
|
|
|||
| from ray.tune.trial import Trial | |||
There was a problem hiding this comment.
Yes seems to be, just updated it to "ray.tune.experiment.trial"
Signed-off-by: linusbiostat <[email protected]>
|
Awesome, thanks - one nit, can we move the Trial import to the top of the code block and leave an empty line after it? |
Yard1
approved these changes
Oct 12, 2022
richardliaw
approved these changes
Oct 12, 2022
Signed-off-by: Antoni Baum <[email protected]>
richardliaw
changed the title
WeichenXu123
pushed a commit
to WeichenXu123/ray
that referenced
this pull request
Dec 19, 2022
Co-authored-by: Antoni Baum <[email protected]> Signed-off-by: Weichen Xu <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: linusbiostat [email protected]
Why are these changes needed?
To make the documentation code work.
TrialTerminationReporter has an init function. Because extending the CliReporter, it's need to take the same init parameters. I've added these with the super() function.
Related issue number
Checks
git commit -s) in this PR.scripts/format.shto lint the changes in this PR.